Skip to content

docs: add not_ready + offset_too_large to canonical error table#193

Merged
Mlaz-code merged 1 commit into
mainfrom
audit/errcodes-not-ready
Apr 24, 2026
Merged

docs: add not_ready + offset_too_large to canonical error table#193
Mlaz-code merged 1 commit into
mainfrom
audit/errcodes-not-ready

Conversation

@Mlaz-code
Copy link
Copy Markdown
Collaborator

Summary

The `overview.mdx` canonical error-codes table was missing two codes that the server already emits and that both SDKs already reference:

  • `offset_too_large` (400) — `/odds` and `/odds/delta` when `offset` > 500. Documented on those endpoint pages already, but absent from the canonical list.
  • `not_ready` (503) — a backing store (ClickHouse, closing-line capture) isn't ready. Added to the Go registry + Python/TS SDKs in companion PRs.

Also updates `conventions.mdx` count from "19 HTTP codes" to "21".

Companion PRs:

Test plan

  • `npm run build` — static export compiles with the updated tables
  • Spot-check `/en/api-reference/overview#error-codes` and `/en/api-reference/conventions` in preview

🤖 Generated with Claude Code

The overview error-codes table was missing two codes that the server
already emits: offset_too_large (400, /odds and /odds/delta when offset
exceeds 500) and not_ready (503, backing store not ready). Both are in
the Python + TS SDKs; only the canonical docs table was behind.

Also updates the count in conventions.mdx from "19 HTTP codes" to 21.
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs.sharpapi.io Ready Ready Preview, Comment Apr 24, 2026 3:36pm

Request Review

@Mlaz-code Mlaz-code merged commit 84d08b5 into main Apr 24, 2026
2 checks passed
@Mlaz-code Mlaz-code deleted the audit/errcodes-not-ready branch April 24, 2026 15:40
Mlaz-code added a commit that referenced this pull request May 7, 2026
The overview error-codes table was missing two codes that the server
already emits: offset_too_large (400, /odds and /odds/delta when offset
exceeds 500) and not_ready (503, backing store not ready). Both are in
the Python + TS SDKs; only the canonical docs table was behind.

Also updates the count in conventions.mdx from "19 HTTP codes" to 21.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant